<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class AuthenticatorBase</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class AuthenticatorBase</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">AuthenticatorBase class</p>
<p class="description"><p>Basic implementation of the <strong>Valve</strong> interface that enforces the  <div class="src-code"><ol><li><div class="src-line">&lt;<span class="src-id">security</span>-<span class="src-id">constraint</span>&gt;</div></li>
</ol></div> elements in the web application  deployment descriptor.  This functionality is implemented as a Valve  so that it can be ommitted in environments that do not require these  features.  Individual implementations of each supported authentication  method can subclass this base class as required.</p><p><strong>USAGE CONSTRAINT</strong>:  When this class is utilized, the Context to  which it is attached (or a parent Container in a hierarchy) must have an  associated Realm that can be used for authenticating users and enumerating  the roles to which they have been assigned.</p><p><strong>USAGE CONSTRAINT</strong>:  This Valve is only useful when processing HTTP  requests.  Requests of any other type will simply be passed through.</p><p></p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jeroen Simons &lt;<a href="mailto:jeroen@melange.nl">jeroen@melange.nl</a>&gt;</li>
				<li><span class="field">copyright:</span> Copyright (c) 2007 Jeroen Simons. All rights reserved</li>
				<li><span class="field">link:</span> <a href="http://www.melange.nl/">http://www.melange.nl/</a></li>
				<li><span class="field">abstract:</span> </li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_aas---authenticator---AuthenticatorBase.php.html">/aas/authenticator/AuthenticatorBase.php</a> (line <span class="field">47</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
					</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../aas/BasicAuthenticator.html">BasicAuthenticator</a></td>
					<td>
											BasicAuthenticator class
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../aas/FormAuthenticator.html">FormAuthenticator</a></td>
					<td>
											FormAuthenticator class
										</td>
				</tr>
							</table>
		</div>
	</div>

	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendants</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#BASIC_METHOD" title="details" class="const-name">BASIC_METHOD</a> = 					<span class="var-type"> &quot;BASIC&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#CERT_METHOD" title="details" class="const-name">CERT_METHOD</a> = 					<span class="var-type"> &quot;CLIENT-CERT&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#DIGEST_METHOD" title="details" class="const-name">DIGEST_METHOD</a> = 					<span class="var-type"> &quot;DIGEST&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FORM_ACTION" title="details" class="const-name">FORM_ACTION</a> = 					<span class="var-type"> &quot;/j_security_check&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FORM_METHOD" title="details" class="const-name">FORM_METHOD</a> = 					<span class="var-type"> &quot;FORM&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FORM_PASSWORD" title="details" class="const-name">FORM_PASSWORD</a> = 					<span class="var-type"> &quot;j_password&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FORM_PRINCIPAL_NOTE" title="details" class="const-name">FORM_PRINCIPAL_NOTE</a> = 					<span class="var-type">
        &quot;nl.melange.phpmvc.authenticator.PRINCIPAL&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FORM_REQUEST_NOTE" title="details" class="const-name">FORM_REQUEST_NOTE</a> = 					<span class="var-type">
        &quot;nl.melange.phpmvc.authenticator.REQUEST&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#FORM_USERNAME" title="details" class="const-name">FORM_USERNAME</a> = 					<span class="var-type"> &quot;j_username&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#SESS_PASSWORD_NOTE" title="details" class="const-name">SESS_PASSWORD_NOTE</a> = 					<span class="var-type">
      &quot;nl.melange.authenticator.session.PASSWORD&quot;</span>

				</div>
								<div class="const-title">
					<img src="../media/images/Constant.png" alt=" " />
					<a href="#SESS_USERNAME_NOTE" title="details" class="const-name">SESS_USERNAME_NOTE</a> = 					<span class="var-type">
      &quot;nl.melange.phpmvc.authenticator.USERNAME&quot;</span>

				</div>
							</div>
		</div>
	</div>

	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																																								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$cache" title="details" class="var-name">$cache</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../http/Context.html">Context</a></span>
					<a href="#$context" title="details" class="var-name">$context</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$disableProxyCaching" title="details" class="var-name">$disableProxyCaching</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																												
												<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#accessControl" title="details" class="method-name">accessControl</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../aas/SecurityConstraint.html">SecurityConstraint</a></span>&nbsp;<span class="var-name">$constraint</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#authenticate" title="details" class="method-name">authenticate</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../aas/LoginConfig.html">LoginConfig</a></span>&nbsp;<span class="var-name">$config</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#findConstraint" title="details" class="method-name">findConstraint</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getCache" title="details" class="method-name">getCache</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getContainer" title="details" class="method-name">getContainer</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getDisableProxyCaching" title="details" class="method-name">getDisableProxyCaching</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#invoke" title="details" class="method-name">invoke</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">context</span>&nbsp;<span class="var-name">2</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#register" title="details" class="method-name">register</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../aas/GenericPrincipal.html">GenericPrincipal</a></span>&nbsp;<span class="var-name">$principal</span>, <span class="var-type">principal</span>&nbsp;<span class="var-name">$authType</span>, <span class="var-type">authType</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">username</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">password</span>&nbsp;<span class="var-name">5</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setCache" title="details" class="method-name">setCache</a>
											(<span class="var-type">cache</span>&nbsp;<span class="var-name">$cache</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setContainer" title="details" class="method-name">setContainer</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$container</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setDisableProxyCaching" title="details" class="method-name">setDisableProxyCaching</a>
											(<span class="var-type">nocache</span>&nbsp;<span class="var-name">$nocache</span>)
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$cache" id="$cache"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$cache</span>
			 = <span class="var-default"> true</span>			(line <span class="line-number">99</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Should we cache authenticated Principals if the request is part of</p>
<p class="description"><p>an HTTP session?</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$context" id="$context"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../http/Context.html">Context</a></span>
			<span class="var-name">$context</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">107</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The Context to which this Valve is attached.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$disableProxyCaching" id="$disableProxyCaching"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$disableProxyCaching</span>
			 = <span class="var-default"> true</span>			(line <span class="line-number">114</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Flag to determine if we disable proxy caching, or leave the issue  up to the webapp developer.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodaccessControl" id="accessControl"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">accessControl</span> (line <span class="line-number">326</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Perform access control based on the specified authorization constraint.</p>
<p class="description"><p>Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if this constraint is satisfied and processing  should continue, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> otherwise.</p></p>
	<ul class="tags">
				<li><span class="field">exception:</span> IOException if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			accessControl
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../aas/SecurityConstraint.html">SecurityConstraint</a></span>&nbsp;<span class="var-name">$constraint</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: Request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: Response we are creating</span>			</li>
					<li>
				<span class="var-type">constraint</span>
				<span class="var-name">$constraint</span><span class="var-description">: Security constraint we are enforcing</span>			</li>
				</ul>
		
			
	</div>
<a name="methodauthenticate" id="authenticate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">authenticate</span> (line <span class="line-number">410</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Authenticate the user making this request, based on the specified  login configuration.  Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if any specified  constraint has been satisfied, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if we have  created a response challenge already.</p>
	<ul class="tags">
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">exception:</span> IOException if an input/output error occurs</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			authenticate
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type"><a href="../aas/LoginConfig.html">LoginConfig</a></span>&nbsp;<span class="var-name">$config</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: Request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: Response we are creating</span>			</li>
					<li>
				<span class="var-type">config</span>
				<span class="var-name">$config</span><span class="var-description">: Login configuration describing how authentication               should be performed</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../aas/BasicAuthenticator.html#methodauthenticate">BasicAuthenticator::authenticate()</a>
								: Authenticate the user making this request, based on the specified  login configuration.  Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if any specified  constraint has been satisfied, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if we have  created a response challenge already.
							</li>
					<li>
				<a href="../aas/FormAuthenticator.html#methodauthenticate">FormAuthenticator::authenticate()</a>
								: Authenticate the user making this request, based on the specified  login configuration.  Return <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if any specified  constraint has been satisfied, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if we have  created a response challenge already.
							</li>
				</ul>
	</div>
<a name="methodfindConstraint" id="findConstraint"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">findConstraint</span> (line <span class="line-number">420</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the SecurityConstraint configured to guard the request URI for  this request, or <div class="src-code"><ol><li><div class="src-line"><span class="src-id">null</span></div></li>
</ol></div> if there is no such constraint.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			findConstraint
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: Request we are processing</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetCache" id="getCache"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getCache</span> (line <span class="line-number">124</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the cache authenticated Principals flag.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getCache
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetContainer" id="getContainer"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getContainer</span> (line <span class="line-number">146</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the Container to which this Valve is attached.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getContainer
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetDisableProxyCaching" id="getDisableProxyCaching"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getDisableProxyCaching</span> (line <span class="line-number">171</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the flag that states if we add headers to disable caching by  proxies.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getDisableProxyCaching
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodinvoke" id="invoke"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">invoke</span> (line <span class="line-number">202</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enforce the security restrictions in the web application deployment  descriptor of our associated Context.</p>
	<ul class="tags">
				<li><span class="field">exception:</span> ServletException if thrown by a processing element</li>
				<li><span class="field">exception:</span> IOException if an input/output error occurs</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			invoke
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>, <span class="var-type">context</span>&nbsp;<span class="var-name">2</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">context</span>
				<span class="var-name">2</span><span class="var-description">: The valve context used to invoke the next valve   in the current processing pipeline</span>			</li>
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: Request to be processed</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">&$response</span><span class="var-description">: Response to be processed</span>			</li>
				</ul>
		
			
	</div>
<a name="methodregister" id="register"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">register</span> (line <span class="line-number">469</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Register an authenticated Principal and authentication type in our  request, in the current session (if there is one), and with our  SingleSignOn valve, if there is one.  Set the appropriate cookie  to be returned.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			register
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$request</span>, <span class="var-type"><a href="../aas/GenericPrincipal.html">GenericPrincipal</a></span>&nbsp;<span class="var-name">$principal</span>, <span class="var-type">principal</span>&nbsp;<span class="var-name">$authType</span>, <span class="var-type">authType</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">username</span>&nbsp;<span class="var-name">$password</span>, <span class="var-type">password</span>&nbsp;<span class="var-name">5</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">password</span>
				<span class="var-name">5</span><span class="var-description">: Password used to authenticate (if any)</span>			</li>
					<li>
				<span class="var-type">request</span>
				<span class="var-name">$request</span><span class="var-description">: The servlet request we are processing</span>			</li>
					<li>
				<span class="var-type">response</span>
				<span class="var-name">$principal</span><span class="var-description">: The servlet response we are generating</span>			</li>
					<li>
				<span class="var-type">principal</span>
				<span class="var-name">$authType</span><span class="var-description">: The authenticated Principal to be registered</span>			</li>
					<li>
				<span class="var-type">authType</span>
				<span class="var-name">$username</span><span class="var-description">: The authentication type to be registered</span>			</li>
					<li>
				<span class="var-type">username</span>
				<span class="var-name">$password</span><span class="var-description">: Username used to authenticate (if any)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetCache" id="setCache"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setCache</span> (line <span class="line-number">136</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the cache authenticated Principals flag.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setCache
		</span>
					(<span class="var-type">cache</span>&nbsp;<span class="var-name">$cache</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">cache</span>
				<span class="var-name">$cache</span><span class="var-description">: The new cache flag</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetContainer" id="setContainer"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setContainer</span> (line <span class="line-number">158</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the Container to which this Valve is attached.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setContainer
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$container</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">container</span>
				<span class="var-name">$container</span><span class="var-description">: The container to which we are attached</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetDisableProxyCaching" id="setDisableProxyCaching"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setDisableProxyCaching</span> (line <span class="line-number">182</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the value of the flag that states if we add headers to disable  caching by proxies.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setDisableProxyCaching
		</span>
					(<span class="var-type">nocache</span>&nbsp;<span class="var-name">$nocache</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">nocache</span>
				<span class="var-name">$nocache</span><span class="var-description">: <div class="src-code"><ol><li><div class="src-line"><span class="src-id">true</span></div></li>
</ol></div> if we add headers to disable proxy               caching, <div class="src-code"><ol><li><div class="src-line"><span class="src-id">false</span></div></li>
</ol></div> if we leave the headers alone.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendants</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constBASIC_METHOD" id="BASIC_METHOD"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">BASIC_METHOD</span>
			 = <span class="const-default"> &quot;BASIC&quot;</span>
			(line <span class="line-number">53</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constCERT_METHOD" id="CERT_METHOD"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">CERT_METHOD</span>
			 = <span class="const-default"> &quot;CLIENT-CERT&quot;</span>
			(line <span class="line-number">54</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constDIGEST_METHOD" id="DIGEST_METHOD"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">DIGEST_METHOD</span>
			 = <span class="const-default"> &quot;DIGEST&quot;</span>
			(line <span class="line-number">55</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constFORM_ACTION" id="FORM_ACTION"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FORM_ACTION</span>
			 = <span class="const-default"> &quot;/j_security_check&quot;</span>
			(line <span class="line-number">57</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constFORM_METHOD" id="FORM_METHOD"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FORM_METHOD</span>
			 = <span class="const-default"> &quot;FORM&quot;</span>
			(line <span class="line-number">56</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constFORM_PASSWORD" id="FORM_PASSWORD"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FORM_PASSWORD</span>
			 = <span class="const-default"> &quot;j_password&quot;</span>
			(line <span class="line-number">58</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constFORM_PRINCIPAL_NOTE" id="FORM_PRINCIPAL_NOTE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FORM_PRINCIPAL_NOTE</span>
			 = <span class="const-default"><br />        &quot;nl.melange.phpmvc.authenticator.PRINCIPAL&quot;</span>
			(line <span class="line-number">79</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The previously authenticated principal (if caching is disabled).</p>
	
	
</div>
<a name="constFORM_REQUEST_NOTE" id="FORM_REQUEST_NOTE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FORM_REQUEST_NOTE</span>
			 = <span class="const-default"><br />        &quot;nl.melange.phpmvc.authenticator.REQUEST&quot;</span>
			(line <span class="line-number">87</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The original request information, to which the user will be  redirected if authentication succeeds.</p>
	
	
</div>
<a name="constFORM_USERNAME" id="FORM_USERNAME"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">FORM_USERNAME</span>
			 = <span class="const-default"> &quot;j_username&quot;</span>
			(line <span class="line-number">59</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
</div>
<a name="constSESS_PASSWORD_NOTE" id="SESS_PASSWORD_NOTE"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">SESS_PASSWORD_NOTE</span>
			 = <span class="const-default"><br />      &quot;nl.melange.authenticator.session.PASSWORD&quot;</span>
			(line <span class="line-number">65</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The notes key for the password used to authenticate this user.</p>
	
	
</div>
<a name="constSESS_USERNAME_NOTE" id="SESS_USERNAME_NOTE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<img src="../media/images/Variable.png" />
		<span class="const-title">
			<span class="const-name">SESS_USERNAME_NOTE</span>
			 = <span class="const-default"><br />      &quot;nl.melange.phpmvc.authenticator.USERNAME&quot;</span>
			(line <span class="line-number">72</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The notes key for the username used to authenticate this user.</p>
	
	
</div>
						
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Sun, 10 Feb 2008 15:16:14 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>